Introduce `ext.dota2` - Dota 2 Game Coordinator extension #460

Aluerie · 2024-01-23T21:56:40Z

🐸 Summary

This PR introduces ext.dota2 extension.

🖍️ TODO

🐍 Migrate ValvePython/dota2 implemented methods.

👨‍💼Player
- request_profile
- ~~request_gc_profile~~ (disabled by valve)
- request_profile_card
- request_player_stats
- request_player_info (disabled by valve?)
- request_conduct_scorecard (behavior score system was revamped though)
- request_hero_standings
⚽Match
- request_matchmaking_stats
- request_match_details
- request_matches
- request_matches_minimal
- request_top_source_tv_games
- request_player_match_history
🥳Party
Sorry, I'm not interested in implementing this atm.
🦞 Lobby
Same^
🗣️Chat
Same^
🤝Shared Objects
- Maybe?
🛠️Utils
- replay_url
- replay_url_from_match
- metadata_url
- metadata_url_from_match

🔚 Checklist

If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes. (a bit?)
This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, ...)

Done with `protoc -I . --python_betterproto_out=protos dota_gcmessages_client_watch.proto` using 1.2.5 betterproto and manual edits

only introduces one method `fetch_top_source_tv_games`

for more information, see https://pre-commit.ci

Gobot1234

Thank you so much for this!

These don't need to be included, they are for steam non-sense.

Also if you wouldn't mind please could you clean up the enum names to remove underscores and normalise them to be PascalCase.

Finally could you add a very barebones test to the tests directory just to ensure that the client is importable

docs/ext/dota2/index.md

steam/ext/dota2/client.py

Co-authored-by: James Hilton-Balfe <gobot1234yt@gmail.com>

for more information, see https://pre-commit.ci

Co-authored-by: James Hilton-Balfe <gobot1234yt@gmail.com>

for more information, see https://pre-commit.ci

Aluerie · 2024-01-24T22:44:36Z

Thanks for the feedback!

Last time I had similar conversation (with Riot Games API wrapper developers) they actually had the opposite opinion - that it's better for both library devs and end-user to just follow "bad naming/practices/models" from the original devs instead of rethinking/over-cooking. The proto-models are here and kinda working - why not just give easy access to them, they aren't so bad, honestly.

Maybe affected by those, I just thought

to compile all protos
to list all known emsg-response pairs
to have easy kwargs->proto interface and let the user do whatever with returned responses.
only then implement helper methods which would modelize the responses.

But I definitely see your points/philosophy. Sorry that I was too linear. Let's modelize this stuff right away then. So... I've done a total overhaul of the PR (maybe I should resubmit it for cleaner commit history?). This is what I changed:

In practice, this top source proto message has very little keyword combinations that work and make sense. Thus, I reimplemented this into 3 separate methods.
I also implemented some models to wrap responses and its fields.
deleted all unused enums and proto messages -> naming and steam nonsense problems are gone.
intial test file.
moved EMsg to enums.py in root of the extension (kinda like yours).
renamed some files to feel more pythonic and less valve-gibbersih prefixes (kinda like yours).

steam/ext/dota2/models.py

Gobot1234

Overall looks very good, nearly there.

Last time I had similar conversation (with Riot Games API wrapper developers) they actually had the opposite opinion - that it's better for both library devs and end-user to just follow "bad naming/practices/models" from the original devs instead of rethinking/over-cooking

I wouldn't disagree if the names were consistent at the very least but with steam they aren't

steam/ext/dota2/protobufs/shared_enums.py

steam/ext/dota2/protobufs/lobby.py

steam/ext/dota2/protobufs/shared_enums.py

steam/ext/dota2/state.py

steam/ext/dota2/models.py

steam/ext/dota2/protobufs/common.py

steam/ext/dota2/protobufs/sdk.py

steam/ext/dota2/protobufs/lobby.py

steam/ext/dota2/protobufs/shared_enums.py

Co-authored-by: James Hilton-Balfe <gobot1234yt@gmail.com>

Black didn't automate it cause fmt: off 😒custom rule-set when

for more information, see https://pre-commit.ci

Idk, is it too bad if I dont title stuff properly

for more information, see https://pre-commit.ci

steam/ext/dota2/client.py

for more information, see https://pre-commit.ci

and a few brush ups

Erm

for more information, see https://pre-commit.ci

…m.py into introduce-ext.dota2

Also got rid of the folder `models`; it was a bad idea.

for more information, see https://pre-commit.ci

Protobufs were updated :x

also fix for OD type 🤦‍♀️

Aluerie and others added 4 commits January 24, 2024 00:01

🪧Compile protobufs into .py mirrors

de7a99f

Done with `protoc -I . --python_betterproto_out=protos dota_gcmessages_client_watch.proto` using 1.2.5 betterproto and manual edits

🐸Initial implementation for Dota2 GC

e21b9ef

only introduces one method `fetch_top_source_tv_games`

📃Initial docs for ext.dota2

513ea0c

[pre-commit.ci] auto fixes from pre-commit.com hooks

60e4c39

for more information, see https://pre-commit.ci

Gobot1234 self-assigned this Jan 23, 2024

Aluerie and others added 2 commits January 24, 2024 01:10

✒️Stealth edit to fetch_top_source_tv_games docstring

89bdc97

[pre-commit.ci] auto fixes from pre-commit.com hooks

dd0a3b8

for more information, see https://pre-commit.ci

Aluerie changed the title ~~Introduce ext.dota2 - Game 2 Game Coordinator extension~~ Introduce ext.dota2 - Dota 2 Game Coordinator extension Jan 23, 2024

Aluerie marked this pull request as ready for review January 23, 2024 22:25

Gobot1234 requested changes Jan 23, 2024

View reviewed changes

Aluerie and others added 7 commits January 23, 2024 23:04

Apply suggestions from code review by Gobot

6355e21

Co-authored-by: James Hilton-Balfe <gobot1234yt@gmail.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

89b5b01

for more information, see https://pre-commit.ci

Apply suggestions from code review

ca12e0e

Co-authored-by: James Hilton-Balfe <gobot1234yt@gmail.com>

⛔Remove Steam NonSense

728fa0e

🔨Fix bad enum namings

f96967f

🪓 Total Overhaul of the PR

494bd5c

[pre-commit.ci] auto fixes from pre-commit.com hooks

f8bd9b6

for more information, see https://pre-commit.ci

Aluerie requested a review from Gobot1234 January 24, 2024 22:45

Aluerie commented Jan 24, 2024

View reviewed changes

steam/ext/dota2/models.py Outdated Show resolved Hide resolved

🖋️Small doc edit

2e9383f

Gobot1234 requested changes Jan 24, 2024

View reviewed changes

Aluerie and others added 3 commits January 25, 2024 00:24

🆘Apply suggestions from code review by Gobot

da096d4

Co-authored-by: James Hilton-Balfe <gobot1234yt@gmail.com>

🩺 More feedback corrections

ab90872

🪿Remove fmt: off from betterproto Enums

c07dff9

Aluerie requested a review from Gobot1234 January 25, 2024 02:20

Aluerie and others added 4 commits January 25, 2024 05:27

🤺Quotes ' -> "

dd1b731

Black didn't automate it cause fmt: off 😒custom rule-set when

🪥 Few more brush ups

db78cd0

[pre-commit.ci] auto fixes from pre-commit.com hooks

8ec073f

for more information, see https://pre-commit.ci

🪥and more

3c89f4a

🔣Doc String + Remove C prefix

59bf6fd

Aluerie marked this pull request as draft January 25, 2024 21:23

Aluerie and others added 4 commits January 27, 2024 04:20

📈 Glicko Rating and Behavior Summary

037355f

[pre-commit.ci] auto fixes from pre-commit.com hooks

5a19a1d

for more information, see https://pre-commit.ci

💥MatchDetails, MM stats, rating - very raw

7e3ddb1

Idk, is it too bad if I dont title stuff properly

[pre-commit.ci] auto fixes from pre-commit.com hooks

3b83928

for more information, see https://pre-commit.ci

Gobot1234 requested changes Feb 4, 2024

View reviewed changes

steam/ext/dota2/client.py Outdated Show resolved Hide resolved

Aluerie and others added 23 commits September 21, 2024 17:27

Merge branch 'Gobot1234:main' into introduce-ext.dota2

b4bd089

[pre-commit.ci] auto fixes from pre-commit.com hooks

69d0c92

for more information, see https://pre-commit.ci

Merge branch 'Gobot1234:main' into introduce-ext.dota2

bd12ec8

🏅Implement RankTier Medals

517e33f

and a few brush ups

🔬Introduce Match Minimal

04fcdef

📂Divide models.py into a folder

5d50888

Create models.py

38a8f39

🧓Match History

702f883

📲Social Feed Post Message

f553a8d

🪥Some Brush-ups

bfef6bd

Erm

〽️Instantiate Partial Match

da9d459

🖼️Profile Request

8d166c3

[pre-commit.ci] auto fixes from pre-commit.com hooks

37a8fa7

for more information, see https://pre-commit.ci

Doc Edits

55f0486

Merge branch 'introduce-ext.dota2' of https://github.com/Aluerie/stea…

87e9220

…m.py into introduce-ext.dota2

🔮Refactor things back to proper state -> models

39f907f

Also got rid of the folder `models`; it was a bad idea.

🔝Separate state for TopSource too

047da1f

🦜Separate state for MM stats

6abe799

[pre-commit.ci] auto fixes from pre-commit.com hooks

12c6df1

for more information, see https://pre-commit.ci

🌐 replay_url, metadata_url

e47e624

🙂Add Facets to protos

4a54ad1

Protobufs were updated :x

🎶Fix Match History

f465544

🆕Add Kez hero

1a96c93

also fix for OD type 🤦‍♀️

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce `ext.dota2` - Dota 2 Game Coordinator extension #460

Introduce `ext.dota2` - Dota 2 Game Coordinator extension #460

Aluerie commented Jan 23, 2024 •

edited

Loading

Gobot1234 left a comment

Aluerie commented Jan 24, 2024 •

edited

Loading

Gobot1234 left a comment

Introduce ext.dota2 - Dota 2 Game Coordinator extension #460

Are you sure you want to change the base?

Introduce ext.dota2 - Dota 2 Game Coordinator extension #460

Conversation

Aluerie commented Jan 23, 2024 • edited Loading

🐸 Summary

🖍️ TODO

🐍 Migrate ValvePython/dota2 implemented methods.

🔚 Checklist

Gobot1234 left a comment

Choose a reason for hiding this comment

Aluerie commented Jan 24, 2024 • edited Loading

Gobot1234 left a comment

Choose a reason for hiding this comment

Introduce `ext.dota2` - Dota 2 Game Coordinator extension #460

Introduce `ext.dota2` - Dota 2 Game Coordinator extension #460

Aluerie commented Jan 23, 2024 •

edited

Loading

Aluerie commented Jan 24, 2024 •

edited

Loading